Get current notification indicator counts

{ getNotificationIndicators }

Returns the current notification indicator counts for the specified user.

Method

/API3/notification/getNotificationIndicators

  • API Section: /API3/notification
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    userId

    Type

    string

    Description

    The system user ID

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    List of notification indicator counts for unread items.

    Notes

    The returned list is the count of unread items as shown in the Bulletin Board

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/notification/getNotificationIndicators" \
     -d ''
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.NotificationServiceApi;
    
    import java.util.*;
    
    public class NotificationServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            NotificationServiceApi apiInstance = new NotificationServiceApi();
            // Initialize the userId parameter object for the call
            String userId = userId_example; // String | 
    
            try {
                NotificationIndicatorsResult result = apiInstance.getNotificationIndicators(userId);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling NotificationServiceApi#getNotificationIndicators");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.NotificationServiceApi("http://Your.Server.URL")
    const opts = {
      'userId': userId_example // {String} 
    };
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getNotificationIndicators(opts, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class getNotificationIndicatorsExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new NotificationServiceApi();
            // Initialize the userId parameter object for the call
            var userId = userId_example;  // String |  (optional) 
    
            try {
                // Returns the current notification indicator counts for the specified user.
                NotificationIndicatorsResult result = apiInstance.getNotificationIndicators(userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationServiceApi.getNotificationIndicators: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.NotificationServiceApi(api_client)
        # Initialize the userId parameter object for the call
        userId = userId_example # String |  (optional)
    
        try:
            # Returns the current notification indicator counts for the specified user.
            api_response = api_instance.get_notification_indicators(userId=userId)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling NotificationServiceApi->getNotificationIndicators: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\NotificationServiceApi();
    $userId = userId_example; // String | 
    
    try {
        $result = $api_instance->getNotificationIndicators($userId);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling NotificationServiceApi->getNotificationIndicators: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.